Skip to content

docs: added a workflow badge #6045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

braveocheretovych
Copy link

Description

Applicable issues

  • fixes #

Additional info (benefits, drawbacks, caveats)

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

@@ -12,6 +12,7 @@ Stacks is a layer-2 blockchain that uses Bitcoin as a base layer for security an

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0)
[![Release](https://img.shields.io/github/v/release/stacks-network/stacks-core?style=flat)](https://github.com/stacks-network/stacks-core/releases/latest)
[![CI](https://github.com/stacks-network/stacks-core/actions/workflows/ci.yml/badge.svg)](https://github.com/stacks-network/stacks-core/actions)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this will convey the data you think it does. that workflow calls several reusable workflows, so the ci.yml workflow only runs a very simple number of steps (rust format and checking if it's a release)
ex:
Screenshot 2025-05-14 at 09 20 06

if there's a way to collate all the resuable workflows for the tests, this may be useful - but as submitted this is not something that improves the data in README.

this would be a tricky one too, since the tests are run via reusable workflow, so they don't appear to have a badge (https://github.com/stacks-network/stacks-core/actions/workflows/bitcoin-tests.yml/badge.svg?branch=develop):
Screenshot 2025-05-14 at 09 21 45

  • note that bitcoin-tests.yml workflow is called on every CI run

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to do it like this, or is it too primitive?
https://img.shields.io/badge/Tests::Bitcoin%20passing-green.svg

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no - that's just a "passing" badge, but there's no data underneat that indicates it is passing.
consider this: https://github.com/stacks-network/stacks-core/actions/workflows/bitcoin-tests.yml/badge.svg?branch=develop

it is checking the workflow bitcoin-tests.yml, but since that is called via a reusable workflow - there is no standalone status to check.

ci.yml is the workflow that calls the reusable workflows, but by itself it does not report the reusable statuses (only the defined steps in ci.yml, which really just rust format and checking if it is a release build or not).

if there is a way to get the full status of all reusable workflows from ci.yml, it may work - but if not, the data reported by the above is not sufficient

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

something like this may work though: https://github.com/orgs/community/discussions/66910#discussioncomment-6999190

the question remains though - is this valuable data to have in the repo? before you attempt to PR the above, i would be prepared to answer that question since it's likely to come up from other reviewers.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I understand you, but I meant this badge https://img.shields.io/badge/Tests::Bitcoin%20passing-green.svg and supplement it with this link https://github.com/stacks-network/stacks-core/actions

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this is something you'd like to see, and since we're using re-usable workflows that don't have an api status - i think the only option to add this would be a change to the workflows to aggregate all the job statuses. i'm not sure how large of a task that would be, or it would be worth the effort - particularly since there are several flaky tests that will randomly fail (and produce a "not passing" badge, but on retry the tests may pass).

but again, i think the question you would have to answer first before trying to get this working is: does this information have value, and to whom?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this information will be useful as many projects use this method to familiarize users with github workflows, but of course the final word is up to you.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's the point i'm trying to make here - if you do decide to PR the above:

  1. it needs to be accurate. i think the method i shared in the discussion link should help you get there
  2. in the PR, you'll need to explain your reasoning as to why this is useful to have

based on those 2 points, the reviewers willl approve/deny/request changes.

meanwhile, i'll close this PR - but feel free to cc me if you open a new one for the above!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand you, thank you for the clarification, we have an agreement.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have another question for you, how do you look at it if I add a badge to the social network Twitter and a link to it next to the discord badge?
https://img.shields.io/twitter/follow/Stacks
https://x.com/stacks

@braveocheretovych braveocheretovych requested a review from wileyj May 14, 2025 17:10
@wileyj wileyj closed this May 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants